<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
  <meta name="description" content="API docs for the BoxHeightStyle enum from the dart:ui library, for the Dart programming language.">
  <title>BoxHeightStyle enum - dart:ui library - Dart API</title>
  <!-- required because all the links are pseudo-absolute -->
  <base href="..">

  <link href="https://fonts.googleapis.com/css?family=Source+Code+Pro:500,400i,400,300|Source+Sans+Pro:400,300,700" rel="stylesheet">
  <link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
  <link rel="stylesheet" href="static-assets/github.css">
  <link rel="stylesheet" href="static-assets/styles.css">
  <link rel="icon" href="static-assets/favicon.png">
  
</head>

<body>

<div id="overlay-under-drawer"></div>

<header id="title">
  <button id="sidenav-left-toggle" type="button">&nbsp;</button>
  <ol class="breadcrumbs gt-separated dark hidden-xs">
    <li><a href="index.html">shake</a></li>
    <li><a href="dart-ui/dart-ui-library.html">dart:ui</a></li>
    <li class="self-crumb">BoxHeightStyle enum</li>
  </ol>
  <div class="self-name">BoxHeightStyle</div>
  <form class="search navbar-right" role="search">
    <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
</header>

<main>

  <div id="dartdoc-sidebar-left" class="col-xs-6 col-sm-3 col-md-2 sidebar sidebar-offcanvas-left">
    <header id="header-search-sidebar" class="hidden-l">
      <form class="search-sidebar" role="search">
        <input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
      </form>
    </header>
    
    <ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
      <li><a href="index.html">shake</a></li>
      <li><a href="dart-ui/dart-ui-library.html">dart:ui</a></li>
      <li class="self-crumb">BoxHeightStyle enum</li>
    </ol>
    
    <h5>dart:ui library</h5>
    <ol>
      <li class="section-title"><a href="dart-ui/dart-ui-library.html#classes">Classes</a></li>
      <li><a href="dart-ui/AccessibilityFeatures-class.html">AccessibilityFeatures</a></li>
      <li><a href="dart-ui/CallbackHandle-class.html">CallbackHandle</a></li>
      <li><a href="dart-ui/Canvas-class.html">Canvas</a></li>
      <li><a href="dart-ui/Codec-class.html">Codec</a></li>
      <li><a href="dart-ui/Color-class.html">Color</a></li>
      <li><a href="dart-ui/ColorFilter-class.html">ColorFilter</a></li>
      <li><a href="dart-ui/EngineLayer-class.html">EngineLayer</a></li>
      <li><a href="dart-ui/FontWeight-class.html">FontWeight</a></li>
      <li><a href="dart-ui/FrameInfo-class.html">FrameInfo</a></li>
      <li><a href="dart-ui/Gradient-class.html">Gradient</a></li>
      <li><a href="dart-ui/Image-class.html">Image</a></li>
      <li><a href="dart-ui/ImageFilter-class.html">ImageFilter</a></li>
      <li><a href="dart-ui/ImageShader-class.html">ImageShader</a></li>
      <li><a href="dart-ui/IsolateNameServer-class.html">IsolateNameServer</a></li>
      <li><a href="dart-ui/Locale-class.html">Locale</a></li>
      <li><a href="dart-ui/MaskFilter-class.html">MaskFilter</a></li>
      <li><a href="dart-ui/Offset-class.html">Offset</a></li>
      <li><a href="dart-ui/OffsetBase-class.html">OffsetBase</a></li>
      <li><a href="dart-ui/Paint-class.html">Paint</a></li>
      <li><a href="dart-ui/Paragraph-class.html">Paragraph</a></li>
      <li><a href="dart-ui/ParagraphBuilder-class.html">ParagraphBuilder</a></li>
      <li><a href="dart-ui/ParagraphConstraints-class.html">ParagraphConstraints</a></li>
      <li><a href="dart-ui/ParagraphStyle-class.html">ParagraphStyle</a></li>
      <li><a href="dart-ui/Path-class.html">Path</a></li>
      <li><a href="dart-ui/PathMetric-class.html">PathMetric</a></li>
      <li><a href="dart-ui/PathMetricIterator-class.html">PathMetricIterator</a></li>
      <li><a href="dart-ui/PathMetrics-class.html">PathMetrics</a></li>
      <li><a href="dart-ui/Picture-class.html">Picture</a></li>
      <li><a href="dart-ui/PictureRecorder-class.html">PictureRecorder</a></li>
      <li><a href="dart-ui/PluginUtilities-class.html">PluginUtilities</a></li>
      <li><a href="dart-ui/PointerData-class.html">PointerData</a></li>
      <li><a href="dart-ui/PointerDataPacket-class.html">PointerDataPacket</a></li>
      <li><a href="dart-ui/Radius-class.html">Radius</a></li>
      <li><a href="dart-ui/Rect-class.html">Rect</a></li>
      <li><a href="dart-ui/RRect-class.html">RRect</a></li>
      <li><a href="dart-ui/RSTransform-class.html">RSTransform</a></li>
      <li><a href="dart-ui/Scene-class.html">Scene</a></li>
      <li><a href="dart-ui/SceneBuilder-class.html">SceneBuilder</a></li>
      <li><a href="dart-ui/SceneHost-class.html">SceneHost</a></li>
      <li><a href="dart-ui/SemanticsAction-class.html">SemanticsAction</a></li>
      <li><a href="dart-ui/SemanticsFlag-class.html">SemanticsFlag</a></li>
      <li><a href="dart-ui/SemanticsUpdate-class.html">SemanticsUpdate</a></li>
      <li><a href="dart-ui/SemanticsUpdateBuilder-class.html">SemanticsUpdateBuilder</a></li>
      <li><a href="dart-ui/Shader-class.html">Shader</a></li>
      <li><a href="dart-ui/Shadow-class.html">Shadow</a></li>
      <li><a href="dart-ui/Size-class.html">Size</a></li>
      <li><a href="dart-ui/StrutStyle-class.html">StrutStyle</a></li>
      <li><a href="dart-ui/Tangent-class.html">Tangent</a></li>
      <li><a href="dart-ui/TextBox-class.html">TextBox</a></li>
      <li><a href="dart-ui/TextDecoration-class.html">TextDecoration</a></li>
      <li><a href="dart-ui/TextPosition-class.html">TextPosition</a></li>
      <li><a href="dart-ui/TextStyle-class.html">TextStyle</a></li>
      <li><a href="dart-ui/Versions-class.html">Versions</a></li>
      <li><a href="dart-ui/Vertices-class.html">Vertices</a></li>
      <li><a href="dart-ui/Window-class.html">Window</a></li>
      <li><a href="dart-ui/WindowPadding-class.html">WindowPadding</a></li>
    
    
    
      <li class="section-title"><a href="dart-ui/dart-ui-library.html#properties">Properties</a></li>
      <li><a href="dart-ui/versions.html">versions</a></li>
      <li><a href="dart-ui/window.html">window</a></li>
    
      <li class="section-title"><a href="dart-ui/dart-ui-library.html#functions">Functions</a></li>
      <li><a href="dart-ui/decodeImageFromList.html">decodeImageFromList</a></li>
      <li><a href="dart-ui/decodeImageFromPixels.html">decodeImageFromPixels</a></li>
      <li><a href="dart-ui/hashList.html">hashList</a></li>
      <li><a href="dart-ui/hashValues.html">hashValues</a></li>
      <li><a href="dart-ui/instantiateImageCodec.html">instantiateImageCodec</a></li>
      <li><a href="dart-ui/lerpDouble.html">lerpDouble</a></li>
      <li><a href="dart-ui/loadFontFromList.html">loadFontFromList</a></li>
      <li><a href="dart-ui/saveCompilationTrace.html">saveCompilationTrace</a></li>
    
      <li class="section-title"><a href="dart-ui/dart-ui-library.html#enums">Enums</a></li>
      <li><a href="dart-ui/AppLifecycleState-class.html">AppLifecycleState</a></li>
      <li><a href="dart-ui/BlendMode-class.html">BlendMode</a></li>
      <li><a href="dart-ui/BlurStyle-class.html">BlurStyle</a></li>
      <li><a href="dart-ui/BoxHeightStyle-class.html">BoxHeightStyle</a></li>
      <li><a href="dart-ui/BoxWidthStyle-class.html">BoxWidthStyle</a></li>
      <li><a href="dart-ui/Brightness-class.html">Brightness</a></li>
      <li><a href="dart-ui/Clip-class.html">Clip</a></li>
      <li><a href="dart-ui/ClipOp-class.html">ClipOp</a></li>
      <li><a href="dart-ui/FilterQuality-class.html">FilterQuality</a></li>
      <li><a href="dart-ui/FontStyle-class.html">FontStyle</a></li>
      <li><a href="dart-ui/ImageByteFormat-class.html">ImageByteFormat</a></li>
      <li><a href="dart-ui/PaintingStyle-class.html">PaintingStyle</a></li>
      <li><a href="dart-ui/PathFillType-class.html">PathFillType</a></li>
      <li><a href="dart-ui/PathOperation-class.html">PathOperation</a></li>
      <li><a href="dart-ui/PixelFormat-class.html">PixelFormat</a></li>
      <li><a href="dart-ui/PointerChange-class.html">PointerChange</a></li>
      <li><a href="dart-ui/PointerDeviceKind-class.html">PointerDeviceKind</a></li>
      <li><a href="dart-ui/PointMode-class.html">PointMode</a></li>
      <li><a href="dart-ui/StrokeCap-class.html">StrokeCap</a></li>
      <li><a href="dart-ui/StrokeJoin-class.html">StrokeJoin</a></li>
      <li><a href="dart-ui/TextAffinity-class.html">TextAffinity</a></li>
      <li><a href="dart-ui/TextAlign-class.html">TextAlign</a></li>
      <li><a href="dart-ui/TextBaseline-class.html">TextBaseline</a></li>
      <li><a href="dart-ui/TextDecorationStyle-class.html">TextDecorationStyle</a></li>
      <li><a href="dart-ui/TextDirection-class.html">TextDirection</a></li>
      <li><a href="dart-ui/TileMode-class.html">TileMode</a></li>
      <li><a href="dart-ui/VertexMode-class.html">VertexMode</a></li>
    
      <li class="section-title"><a href="dart-ui/dart-ui-library.html#typedefs">Typedefs</a></li>
      <li><a href="dart-ui/FrameCallback.html">FrameCallback</a></li>
      <li><a href="dart-ui/ImageDecoderCallback.html">ImageDecoderCallback</a></li>
      <li><a href="dart-ui/PlatformMessageCallback.html">PlatformMessageCallback</a></li>
      <li><a href="dart-ui/PlatformMessageResponseCallback.html">PlatformMessageResponseCallback</a></li>
      <li><a href="dart-ui/PointerDataPacketCallback.html">PointerDataPacketCallback</a></li>
      <li><a href="dart-ui/SemanticsActionCallback.html">SemanticsActionCallback</a></li>
      <li><a href="dart-ui/VoidCallback.html">VoidCallback</a></li>
    
    </ol>
  </div>

  <div id="dartdoc-main-content" class="col-xs-12 col-sm-9 col-md-8 main-content">
      <div><h1>BoxHeightStyle enum </h1></div>

    <section class="desc markdown">
      <p>Defines various ways to vertically bound the boxes returned by
<a href="dart-ui/Paragraph/getBoxesForRange.html">Paragraph.getBoxesForRange</a>.</p>
    </section>
    

    <section class="summary offset-anchor" id="constants">
      <h2>Constants</h2>

      <dl class="properties">
        <dt id="includeLineSpacingBottom" class="constant">
          <span class="name ">includeLineSpacingBottom</span>
          <span class="signature">&#8594; const <a href="dart-ui/BoxHeightStyle-class.html">BoxHeightStyle</a></span>
                  </dt>
        <dd>
          <p>Extends the bottom edge of the bounds to fully cover any line spacing.</p>
<p>The line spacing will be added to the bottom of the box.</p>
<p>The top edge of each line should be the same as the bottom edge
of the line above. There should be no gaps in vertical coverage given any
amount of line spacing. Line spacing is not included above the first line
and below the last line due to no additional space present there.</p>
                  
  <div>
            <span class="signature"><code>const BoxHeightStyle(4)</code></span>
          </div>
        </dd>
        <dt id="includeLineSpacingMiddle" class="constant">
          <span class="name ">includeLineSpacingMiddle</span>
          <span class="signature">&#8594; const <a href="dart-ui/BoxHeightStyle-class.html">BoxHeightStyle</a></span>
                  </dt>
        <dd>
          <p>Extends the top and bottom edge of the bounds to fully cover any line
spacing.</p>
<p>The top and bottom of each box will cover half of the
space above and half of the space below the line.</p>
<p>The top edge of each line should be the same as the bottom edge
of the line above. There should be no gaps in vertical coverage given any
amount of line spacing. Line spacing is not included above the first line
and below the last line due to no additional space present there.</p>
                  
  <div>
            <span class="signature"><code>const BoxHeightStyle(2)</code></span>
          </div>
        </dd>
        <dt id="includeLineSpacingTop" class="constant">
          <span class="name ">includeLineSpacingTop</span>
          <span class="signature">&#8594; const <a href="dart-ui/BoxHeightStyle-class.html">BoxHeightStyle</a></span>
                  </dt>
        <dd>
          <p>Extends the top edge of the bounds to fully cover any line spacing.</p>
<p>The line spacing will be added to the top of the box.</p>
<p>null</p>
                  
  <div>
            <span class="signature"><code>const BoxHeightStyle(3)</code></span>
          </div>
        </dd>
        <dt id="max" class="constant">
          <span class="name ">max</span>
          <span class="signature">&#8594; const <a href="dart-ui/BoxHeightStyle-class.html">BoxHeightStyle</a></span>
                  </dt>
        <dd>
          <p>The height of the boxes will be the maximum height of all runs in the
line. All boxes in the same line will be the same height. This does not
guarantee that the boxes will cover the entire vertical height of the line
when there is additional line spacing.</p>
<p>See <a href="dart-ui/BoxHeightStyle-class.html">RectHeightStyle.includeLineSpacingTop</a>, <a href="dart-ui/BoxHeightStyle-class.html">RectHeightStyle.includeLineSpacingMiddle</a>,
and <a href="dart-ui/BoxHeightStyle-class.html">RectHeightStyle.includeLineSpacingBottom</a> for styles that will cover
the entire line.</p>
                  
  <div>
            <span class="signature"><code>const BoxHeightStyle(1)</code></span>
          </div>
        </dd>
        <dt id="tight" class="constant">
          <span class="name ">tight</span>
          <span class="signature">&#8594; const <a href="dart-ui/BoxHeightStyle-class.html">BoxHeightStyle</a></span>
                  </dt>
        <dd>
          <p>Provide tight bounding boxes that fit heights per run. This style may result
in uneven bounding boxes that do not nicely connect with adjacent boxes.</p>
                  
  <div>
            <span class="signature"><code>const BoxHeightStyle(0)</code></span>
          </div>
        </dd>
        <dt id="values" class="constant">
          <span class="name ">values</span>
          <span class="signature">&#8594; const <a href="dart-core/List-class.html">List</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="dart-ui/BoxHeightStyle-class.html">BoxHeightStyle</a></span>&gt;</span></span>
                  </dt>
        <dd>
          <p>A constant List of the values in this enum, in order of their declaration.</p>
                  
  <div>
            <span class="signature"><code>const List&lt;<wbr><span class="type-parameter">BoxHeightStyle</span>&gt;</code></span>
          </div>
        </dd>
      </dl>
    </section>


    <section class="summary offset-anchor" id="instance-properties">
      <h2>Properties</h2>

      <dl class="properties">
        <dt id="index" class="property">
          <span class="name">index</span>
          <span class="signature">&#8594; <a href="dart-core/int-class.html">int</a></span>         
        </dt>
        <dd>
          <p>The integer index of this enum.</p>
                  <div class="features">final</div>
</dd>
        <dt id="hashCode" class="property inherited">
          <span class="name"><a href="dart-core/Object/hashCode.html">hashCode</a></span>
          <span class="signature">&#8594; <a href="dart-core/int-class.html">int</a></span>         
        </dt>
        <dd class="inherited">
          The hash code for this object. <a href="dart-core/Object/hashCode.html">[...]</a>
                  <div class="features">read-only, inherited</div>
</dd>
        <dt id="runtimeType" class="property inherited">
          <span class="name"><a href="dart-core/Object/runtimeType.html">runtimeType</a></span>
          <span class="signature">&#8594; <a href="dart-core/Type-class.html">Type</a></span>         
        </dt>
        <dd class="inherited">
          A representation of the runtime type of the object.
                  <div class="features">read-only, inherited</div>
</dd>
      </dl>
    </section>

    <section class="summary offset-anchor" id="instance-methods">
      <h2>Methods</h2>
      <dl class="callables">
        <dt id="toString" class="callable">
          <span class="name"><a href="dart-ui/BoxHeightStyle/toString.html">toString</a></span><span class="signature">(<wbr>)
            <span class="returntype parameter">&#8594; <a href="dart-core/String-class.html">String</a></span>
          </span>
                  </dt>
        <dd>
          Returns a string representation of this object.
                  <div class="features">override</div>
</dd>
        <dt id="noSuchMethod" class="callable inherited">
          <span class="name"><a href="dart-core/Object/noSuchMethod.html">noSuchMethod</a></span><span class="signature">(<wbr><span class="parameter" id="noSuchMethod-param-invocation"><span class="type-annotation"><a href="dart-core/Invocation-class.html">Invocation</a></span> <span class="parameter-name">invocation</span></span>)
            <span class="returntype parameter">&#8594; dynamic</span>
          </span>
                  </dt>
        <dd class="inherited">
          Invoked when a non-existent method or property is accessed. <a href="dart-core/Object/noSuchMethod.html">[...]</a>
                  <div class="features">inherited</div>
</dd>
      </dl>
    </section>

    <section class="summary offset-anchor inherited" id="operators">
      <h2>Operators</h2>
      <dl class="callables">
        <dt id="operator ==" class="callable inherited">
          <span class="name"><a href="dart-core/Object/operator_equals.html">operator ==</a></span><span class="signature">(<wbr><span class="parameter" id="==-param-other"><span class="type-annotation">dynamic</span> <span class="parameter-name">other</span></span>)
            <span class="returntype parameter">&#8594; <a href="dart-core/bool-class.html">bool</a></span>
          </span>
                  </dt>
        <dd class="inherited">
          The equality operator. <a href="dart-core/Object/operator_equals.html">[...]</a>
                  <div class="features">inherited</div>
</dd>
      </dl>
    </section>


  </div> <!-- /.main-content -->

  <div id="dartdoc-sidebar-right" class="col-xs-6 col-sm-6 col-md-2 sidebar sidebar-offcanvas-right">
    <ol>
      <li class="section-title"><a href="dart-ui/BoxHeightStyle-class.html#constants">Constants</a></li>
      <li>includeLineSpacingBottom</li>
      <li>includeLineSpacingMiddle</li>
      <li>includeLineSpacingTop</li>
      <li>max</li>
      <li>tight</li>
      <li>values</li>
    
    
      <li class="section-title">
        <a href="dart-ui/BoxHeightStyle-class.html#instance-properties">Properties</a>
      </li>
      <li>index</li>
      <li class="inherited"><a href="dart-core/Object/hashCode.html">hashCode</a></li>
      <li class="inherited"><a href="dart-core/Object/runtimeType.html">runtimeType</a></li>
    
      <li class="section-title"><a href="dart-ui/BoxHeightStyle-class.html#instance-methods">Methods</a></li>
      <li><a href="dart-ui/BoxHeightStyle/toString.html">toString</a></li>
      <li class="inherited"><a href="dart-core/Object/noSuchMethod.html">noSuchMethod</a></li>
    
      <li class="section-title inherited"><a href="dart-ui/BoxHeightStyle-class.html#operators">Operators</a></li>
      <li class="inherited"><a href="dart-core/Object/operator_equals.html">operator ==</a></li>
    
    
    </ol>
  </div><!--/.sidebar-offcanvas-->

</main>

<footer>
  <span class="no-break">
    shake 0.1.0
  </span>

  
</footer>

<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
<script src="static-assets/typeahead.bundle.min.js"></script>
<script src="static-assets/highlight.pack.js"></script>
<script src="static-assets/URI.js"></script>
<script src="static-assets/script.js"></script>


</body>

</html>
